package com.asialjim.wechat.core.api;

import com.asialjim.wechat.apiservice.Api;

/**
 * <h1><em>ASIAL JIM JAVA DOC</em></h1><hr/>
 * <h2>CLASS DESCRIPTION <i>[ NAME: BaseWeChatApi ]</i></h2><strong>
 * <p> base we-chat api
 * </strong><p><p><em>Copyright &copy; Asial Jim Co., LTD</em><hr/>
 *
 * @author Asial Jim &nbsp;&nbsp; <span>Email:<a href="mailto:asialjim@hotmail.com">asialjim@hotmail.com</a> &nbsp;&nbsp; <a href="asialjim@qq.com">asialjim@qq.com</a></span>
 * @version 1.0.0
 * @since 2021/3/11   &nbsp;&nbsp; JDK 8
 */
public interface BaseWeChatApi extends Api {

    /**
     * <h3>METHOD DESCRIPTION <i>[ NAME: getAccessTokenType ]</i></h3>
     * we-chat api access token type
     * @return {@link WeChatApiAccessTokenType access token type}
     * @author Asial Jim &nbsp;&nbsp; <span>Email: &nbsp;&nbsp; <a href="mailto:asialjim@hotmail.com">asialjim@hotmail.com</a> &nbsp;&nbsp; <a href="asialjim@qq.com">asialjim@qq.com</a></span>
     * @since 2021/3/11 15:04
     */
    WeChatApiAccessTokenType getAccessTokenType();

    /**
     * <h3>METHOD DESCRIPTION <i>[ NAME: accessTokenTypeEqual ]</i></h3>
     * access token type equal
     * @param accessTokenType {@link WeChatApiAccessTokenType access token type}
     * @return {@link Boolean equal}
     * @author Asial Jim &nbsp;&nbsp; <span>Email: &nbsp;&nbsp; <a href="mailto:asialjim@hotmail.com">asialjim@hotmail.com</a> &nbsp;&nbsp; <a href="asialjim@qq.com">asialjim@qq.com</a></span>
     * @since 2021/3/11 15:17
     */
    default boolean accessTokenTypeEqual(WeChatApiAccessTokenType accessTokenType){
        return getAccessTokenType().equals(accessTokenType);
    }
}